﻿// ———————————————————————–
// <copyright file="EventLinkRelation.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// EventLinkRelation.cs:
//
// Type of relationship in EM Event Link
//
// Project: IC.NET - CAD Library
// Author:  Jim Cronin - MITRE
/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)

using System;
using System.Xml;

namespace EDXLSharp.NIEMCADLib
{
  /// <summary>
  /// Represents the type of relationship in an <see cref="EDXLSharp.NIEMCADLib.EventLink"/>
  /// </summary>
  public class EventLinkRelation : IComposable
  {
    /// <summary>
    /// Link LinkRelation Code
    /// </summary>
    public EventLinkRelationCode Code { get; set; }

    /// <summary>
    /// Writes this Object to an inline XML Document
    /// </summary>
    /// <param name="xwriter">Valid XMLWriter</param>
    /// <exception cref="System.ArgumentNullException">Thrown if xwriter is null</exception>
    public void WriteXML(XmlWriter xwriter)
    {
      if (xwriter == null)
      {
        throw new ArgumentNullException("xwriter");
      }

      xwriter.WriteElementString(EDXLConstants.EMEventPrefix, "EventLinkRelationCode", EDXLConstants.EMEventNamespace, Code.GetText());
    }

    /// <summary>
    /// Reads this Object's values from an XML NodeList
    /// </summary>
    /// <param name="rootnode">Root XML Node of the Object Element</param>
    public void ReadXML(XmlNode rootnode)
    {
      if (rootnode == null)
      {
        throw new ArgumentNullException("rootnode");
      }
      if (rootnode.LocalName != "EventLinkRelationCode")
      {
        throw new ArgumentException("Node is not EventLinkRelationCode");
      }

      this.Code = EventLinkRelationCodeHelpers.GetCode(rootnode.InnerText);
    }

    public void Validate()
    {
      //constrained to an enumeration; no further validation needed
    }
  }
}